home *** CD-ROM | disk | FTP | other *** search
/ Aminet 15 / Aminet 15 - Nov 1996.iso / Aminet / dev / gcc / ixemsdk.lha / man / cat2 / profil.0 < prev    next >
Text File  |  1996-09-01  |  2KB  |  56 lines
  1.  
  2. PROFIL(2)                  UNIX Programmer's Manual                  PROFIL(2)
  3.  
  4. NNAAMMEE
  5.      pprrooffiill - control process profiling
  6.  
  7. SSYYNNOOPPSSIISS
  8.      _i_n_t
  9.      pprrooffiill(_c_h_a_r _*_s_a_m_p_l_e_s, _i_n_t _s_i_z_e, _i_n_t _o_f_f_s_e_t, _i_n_t _s_c_a_l_e)
  10.  
  11. DDEESSCCRRIIPPTTIIOONN
  12.      The pprrooffiill() function enables or disables program counter profiling of
  13.      the current process.  If profiling is enabled, then at every clock tick,
  14.      the kernel updates an appropriate count in the _s_a_m_p_l_e_s buffer.
  15.  
  16.      The buffer _s_a_m_p_l_e_s contains _s_i_z_e bytes and is divided into a series of
  17.      16-bit bins.  Each bin counts the number of times the program counter was
  18.      in a particular address range in the process when a clock tick occurred
  19.      while profiling was enabled.  For a given program counter address, the
  20.      number of the corresponding bin is given by the relation:
  21.  
  22.            [(pc - offset) / 2] * scale / 65536
  23.  
  24.      The _o_f_f_s_e_t parameter is the lowest address at which the kernel takes pro-
  25.      gram counter samples.  The _s_c_a_l_e parameter ranges from 1 to 65536 and can
  26.      be used to change the span of the bins.  A scale of 65536 maps each bin
  27.      to 2 bytes of address range; a scale of 32768 gives 4 bytes, 16384 gives
  28.      8 bytes and so on.  Intermediate values provide approximate intermediate
  29.      ranges.  A _s_c_a_l_e value of 0 disables profiling.
  30.  
  31. RREETTUURRNN VVAALLUUEESS
  32.      If the _s_c_a_l_e value is nonzero and the buffer _s_a_m_p_l_e_s contains an illegal
  33.      address, pprrooffiill() returns -1, profiling is terminated and _e_r_r_n_o is set
  34.      appropriately.  Otherwise pprrooffiill() returns 0.
  35.  
  36. FFIILLEESS
  37.      /usr/lib/gcrt0.o  profiling C run-time startup file
  38.      gmon.out          conventional name for profiling output file
  39.  
  40. EERRRROORRSS
  41.      The following error may be reported:
  42.  
  43.      [EFAULT]      The buffer _s_a_m_p_l_e_s contains an invalid address.
  44.  
  45. SSEEEE AALLSSOO
  46.      gprof(1)
  47.  
  48. BBUUGGSS
  49.      This routine should be named pprrooffiillee().
  50.  
  51.      The _s_a_m_p_l_e_s argument should really be a vector of type _u_n_s_i_g_n_e_d _s_h_o_r_t.
  52.  
  53.      The format of the gmon.out file is undocumented.
  54.  
  55. BSD Experimental               September 1, 1996                             1
  56.